home *** CD-ROM | disk | FTP | other *** search
/ Power Tools 1993 October - Disc 2 / Power Tools (Disc 2)(October 1993)(HP).iso / hotlines / network / snaplus2 / api.txt < prev    next >
Text File  |  1993-04-29  |  17KB  |  339 lines
  1. HP-UX SNAplusAPI, Technical Data
  2.    For HP 9000 Series 300, 400, 700, and 800 Computer Systems
  3. Product Number J2235A, J2229A, and J2223A
  4. The HP-UX SNAplusAPI (Application Programming Interface) product
  5. provides programmatic interfaces for developing applications for
  6. program-to-program communication in hierarchical or peer-to-peer
  7. environments.
  8.    HP-UX SNAplusAPI includes LU type 6.2 API, Network Management API and
  9. LUA API.
  10.  
  11. [Figure: , Caption: none]
  12.  
  13. LU type 6.2 allows for Advanced Program-to-Program Communication (APPC)
  14. between applications distributed across a network; Network Management
  15. API, provides an application program interface for communicating with
  16. the NetView program; and LUA enables access to remote applications using
  17. any of the LU types 0, 1, 2, or 3.
  18.    Combined with the HP-UX SNAplusLink product, HP-UX SNAplusAPI gives
  19. HP customers the ability to develop applications that are distributed
  20. between an HP 9000 computer and an IBM System.
  21.    The HP-UX SNAplusAPI product can be run in either a stand-alone or
  22. client/server environment.  The stand-alone environment allows access to
  23. IBM systems from a single HP-UX computer which has its own HP-UX
  24. SNAplusLink.  The client/server environment permits access to the IBM
  25. systems from multiple HP-UX systems on an Ethernet or Token Ring LAN.
  26. Client systems generally use a single HP 9000 system with SNAplusLink as
  27. a server to access the IBM systems.
  28.  
  29. Features
  30. LU 6.2 API provides:
  31. o Basic and mapped conversation verbs allow HP 9000 programmers to
  32.   implement program-to-program communication in an SNA network.
  33. o Systems running SNAplusAPI can communicate with peer systems directly
  34.   by taking advantage of SNAplusLink's Node Type 2.1 or systems can
  35.   communicate with an IBM mainframe using Node Type 2.0.
  36. o Up to 254 LU-LU sessions per system can run simultaneously, each
  37.   session responsible for a separate communication task or for adding
  38.   additional bandwidth to a single communication task.  Each application
  39.   Transaction Program can handle up to 64 LU-LU sessions.
  40. o A system running SNAplusAPI application can act as a Low Entry Network
  41.   (LEN) node in an IBM Advance Peer-to-Peer Network (APPN) environment.
  42. o Enables a remote LU 6.2 application to request an HP 9000 LU 6.2
  43.   application to start running and begin communicating with it.
  44. o The HP-UX SNAplusAPI is completely compatible with other HP 9000
  45.   SNAplus services.  These products may all be running simultaneously
  46.   over the same SNAplusLink to the SNA network.
  47. o HP 9000 application programmers can track all LU 6.2 verb calls within
  48.   applications being developed.  This acts as a valuable debugging aid
  49.   during program development.
  50. o Application programs on the HP 9000 are written in C Language.
  51. o Support for Dependent and Independent LUs
  52. o Session-level and conversation-level security with encrypted passwords
  53. o Ability to send Program Initialization Parameters (PIP)
  54. o Control Operator Verbs for controlling and monitoring APPC sessions
  55.  
  56. The LUA interface:
  57. o Allows user applications to communicate using LU types 0, 1, 2, or 3.
  58. o Is compatible with the Request Unit Interface (RUI) interface of IBM
  59.   OS/2 Extended Edition version 1.2 LUA.
  60. o Supports the following verbs:
  61. RUI_BID
  62. RUI_INIT
  63. RUI_PURGE
  64. RUI_READ
  65. RUI_TERM
  66. RUI_WRITE
  67.  
  68. The Network Management API interface:
  69. o Communicates with the NetView program
  70. o Can send and receive NetView Network Management Vector Transport
  71.   messages (NMVTs).
  72. o Supports the following verbs:
  73. NM_OPEN
  74. NM_CLOSE
  75. NM_RECEIVE
  76. NM_SEND
  77.  
  78. Functional Description
  79. LU6.2 API provides a set of basic and mapped conversation and
  80. type-independent verbs for application programmers to use for
  81. program-to-program communication.  The product is a C library which is
  82. linked into the user's application Transaction Program (TP) to gain
  83. access to the IBM system.  Communication can take place between an
  84. HP 9000 application program and either a CICS application program
  85. running on an IBM mainframe or an application program running on an IBM
  86. peer system such as the AS/400.  These verbs initiate LU 6.2
  87. conversations, send and receive data over these conversations on behalf
  88. of program pairs needing to communicate to complete a "transaction."
  89. Examples of transactions are database updates and file transfers.
  90.  
  91. HP-UX LU 6.2 API Verb Summary
  92. ------------------------------------------------------------------------
  93. Verb                          Function
  94. ------------------------------------------------------------------------
  95. [mc_]allocate                 Establishes a conversation between two
  96.                               TPs.
  97. ------------------------------------------------------------------------
  98. [mc_]confirm                  Sends a confirmation request to the remote
  99.                               TP and waits for a reply.
  100. ------------------------------------------------------------------------
  101. [mc_]confirmed                Sends a confirmation reply to the remote
  102.                               TP in response to receiving a confirmation
  103.                               request.
  104. ------------------------------------------------------------------------
  105. [mc_]deallocate               Ends a conversation between TPs.
  106. ------------------------------------------------------------------------
  107. [mc_]flush                    Flushes the LU's send buffer.
  108. ------------------------------------------------------------------------
  109. [mc_]get_attributes           Returns information pertaining to a
  110.                               conversation.
  111. ------------------------------------------------------------------------
  112. [mc_]prepare_to_receive       Changes the conversation from send to
  113.                               receive state in preparation for receiving
  114.                               data.
  115. ------------------------------------------------------------------------
  116. [mc_]receive_and_post         Causes the LU to post the conversation
  117.                               when information is available for the
  118.                               local TP to receive.
  119. ------------------------------------------------------------------------
  120. [mc_]receive_and_wait         Waits for information to arrive on the
  121.                               conversation and then receives the
  122.                               information.  The information can be data,
  123.                               conversation status, or request for
  124.                               confirmation.
  125.  ----------------------------------------------------------------------
  126. [mc_]receive_immediate        Receives any information available on the
  127.                               conversation without waiting.
  128. ________________________________________________________________________
  129. [mc_]request_to_send          Notifies the remote TP that the local TP
  130.                               is requesting to send data for the
  131.                               conversation.
  132. ________________________________________________________________________
  133. [mc_]send_data                Sends data to the remote TP.
  134. ________________________________________________________________________
  135. [mc_]send_error               Informs the remote TP that the local TP
  136.                               has detected an error.
  137. ________________________________________________________________________
  138. [mc_]test_rts                 Tests the conversation for the receipt of
  139.                               a conversation control request.
  140. ________________________________________________________________________
  141. convert                       Converts EBCDIC data to ASCII and ASCII
  142.                               data to EBCDIC.
  143. ________________________________________________________________________
  144. get_type                      Returns information pertaining to a
  145.                               conversation.
  146. ________________________________________________________________________
  147. receive_allocate              Receives the request from a remote TP to
  148.                               start a conversation and then establishes
  149.                               the conversation.
  150. ________________________________________________________________________
  151. tp_started                    Starts the TP, establishes an IPC
  152.                               connection to a named SNALink server.
  153. ________________________________________________________________________
  154. tp_ended                      Ends the TP, stops an IPC connection to a
  155.                               named SNALink server.
  156. ________________________________________________________________________
  157. Note:  [mc_] is optional form for mapped conversations verbs.
  158.  
  159. In addition to the LU 6.2 verbs, the product provides the following
  160. option sets as defined by IBM in the "Transaction Programmer's Reference
  161. Manual for LU 6.2":
  162.  
  163.  
  164. Option Sets
  165. o Immediate allocation of a session
  166. o PIP data
  167. o Flush the LU's send buffer
  168. o Prepare to receive
  169. o Long locks
  170. o Post on receipt with wait
  171. o Post on receipt with test for posting
  172. o Test request-to-send received
  173. o Receive immediate
  174. o Get conversation attributes
  175. o Session level LU-LU verification
  176. o User ID verification
  177. o Program supplied user ID and password
  178. o Logging of data in system log
  179. o Get attributes
  180. o Mapped conversation LU Services component
  181. o Minimum contention winners (target) parameter
  182. o Drain target (no) parameter
  183. o Force parameter
  184. o LU-LU session limit
  185. o Locally known LU names
  186. o Maximum RU size bounds
  187. o Contention winner automatic activation limit
  188.  
  189. Customer Installation Responsibility
  190. Installation of these products requires knowledge in several overlapping
  191. areas.  The staff engineer responsible for this task must have strong
  192. knowledge of (or have direct contact with staff with strong knowledge
  193. of):  SNA networks, application environments, and HP-UX system
  194. administration.
  195.    Installation requires basic SNA knowledge.  This includes knowledge
  196. of interface nodes, network routers, NAUs, PUs, LUs, link types, IBM
  197. hardware and software.
  198.    The installer must understand why the SNAplus products are being
  199. installed, how the users are going to use SNAplus and how SNAplus fits
  200. into the network solution.
  201.    Installation of SNAplus requires a thorough user-level knowledge of
  202. HP-UX commands.  In addition, the installer must be familiar with:
  203.   - running update on an HP-UX system
  204.   - running SAM (in order to add users)
  205.   - the HP-UX file system, privilege groups, and real-time features
  206.   - running LAN and PSI diagnostics on an HP-UX system
  207.   - HP-UX kernel configuration
  208. Customers who cannot compose a team with this skill set should purchase
  209. HP Installation and Network Startup services.
  210.    Additional Implementation Assistance
  211. For implementation needs that go beyond installation, the customer can
  212. either provide self-support, or can purchase additional services from
  213. HP.  These services include Network Startup and HP ConsultLine.  In
  214. addition, the customer can also purchase service from HP on a
  215. time-and-materials basis.
  216.    Network Startup includes implementation scheduling and coordination
  217. assistance, network configuration and verification testing, and network
  218. documentation.
  219.  
  220. Product Requirements
  221. ------------------------------------------------------------------------
  222. Environment         SNAplusAPI        SNAplusAPI      SNAplusAPI
  223.                     S/300, S/400      S/700           S/800
  224. ------------------------------------------------------------------------
  225. Models              3xx, 4xx          7xx             8x7, 890/1-2,
  226.                                                       890/3-4
  227. ------------------------------------------------------------------------
  228. Operating System                      HP-UX 9.0 or later
  229. ------------------------------------------------------------------------
  230. STREAMS/UX          J2231A            J2232A          J2237A
  231. ------------------------------------------------------------------------
  232. SNAplusLink         Not available     J2226A          J2220A
  233. ------------------------------------------------------------------------
  234. LAN/9000                              Bundled with HP-UX 9000 systems
  235. ------------------------------------------------------------------------
  236. Token Ring/9000     Not available     J2165A          J2166A
  237. ------------------------------------------------------------------------
  238. Disk Space          3 MBytes          5.9 MBytes      3.8 MBytes
  239. ------------------------------------------------------------------------
  240. Memory Space        800 KBytes        800 KBytes      800 KBytes
  241. ------------------------------------------------------------------------
  242. IBM Host  IBM System/370 or compatible mainframe (Series 30xx or 43xx)
  243.           in an SNA environment, MVS or MVS/XA operating systems,
  244.           ACF/VTAM and ACF/NCP, CICS (version 1.7 or later)
  245. ------------------------------------------------------------------------
  246. IBM Midrange   Examples of systems supported are AS/400, S/36, S/38 or
  247.                IBM systems that can be supported in IBM's APPN
  248.                environment.  IBM system links must support Node Type
  249.                2.1.  IBM systems must be running the latest operating
  250.                system version.
  251. ------------------------------------------------------------------------
  252.  
  253. Ordering Information
  254. HP-UX SNAplusAPI includes right-to-use license and software.  For
  255. Series 300, 400, and 700, customer must specify software version option
  256. and a media option, and for the Series 800, a processor option.
  257.    HP-UX SNAplusAPI requires HP STREAMS/UX for Series 300, 400, 700, and
  258. 800 running HP-UX 9.0.
  259.  
  260. J2235A HP-UX SNAplusAPI for Series 300/400
  261. AA0  1/4-inch Linus Cartridge
  262. AAU  CD ROM
  263. APB  HP-UX 8.0
  264. APH  HP-UX 9.0
  265. 0B0  Delete Manuals
  266. 0BG  HP-UX SNAplusAPI APPC Programmer's Migration Guide (J2223-61012)
  267.  
  268. J2229A HP-UX SNAplusAPI for Series 700
  269. AAH  DAT
  270.  
  271. AAU  CD ROM
  272. APF  HP-UX 8.07
  273. APH  HP-UX 9.0
  274. 0B0  Delete Manuals
  275. 0BG  HP-UX SNAplusAPI APPC Programmer's Migration Guide (J2223-61012)
  276.  
  277. J2223A HP-UX SNAplusAPI for Series 800
  278. AA0  1/4-inch Linus Cartridge
  279. AA1  1600 bpi Magnetic Tape
  280. AAH  DAT
  281. AA4  QIC Cartridge Tape
  282. AAU  CD ROM
  283. APB  HP-UX 8.0
  284. APH  HP-UX 9.0
  285. 0B0  Delete Manuals
  286. 0BG  HP-UP SNAplusAPI APPC Programmer's Migration Guide (J2223-61012)
  287.  
  288. Processor Options
  289. AH0  807/817
  290. AEL  827/837
  291. AE5  847/857
  292. AE6  867/877
  293. AEN  887/897
  294. AEP  890/1-2
  295. AH1  890/3-4
  296.  
  297. HP-UX SNAplusAPI requires previous installation of HP-UX SNAplusLink
  298. (J2220A or J2226A) either on the stand-alone or on the server system.
  299. The software which the customer orders contains both the stand-alone and
  300. client/server configuration software.  During installation, the customer
  301. chooses which configuration is required.
  302.    Upgrade options are available for Series 800 SNAplus products.
  303. Please consult the HP 9000 price guide for details.
  304.    Note:  A copy of HP-UX SNAplusAPI must be ordered for each HP-UX
  305. system which is to communicate with the IBM mainframe through the
  306. server.
  307.  
  308. Documentation for HP-UX 9.0
  309. J2223-61008 HP-UX SNAplusAPI Administrator's Guide
  310. J2223-61009 HP-UX SNAplusAPI APPC Programmer's Guide
  311. J2223-61010 HP-UX SNAplusAPI LUA Programmer's Guide
  312. J2223-61011 HP-UX SNAplusAPI Common Service Verbs Programmer's Guide
  313. J2223-61013 HP-UX SNAplusAPI Network Management API Programmer's Guide
  314. J2220-61021 HP-UX SNAplus Installation Guide
  315. J2220-61025 HP SNA Products Remote System Configuration Guide
  316.  
  317. Documentation for HP-UX 8.0
  318. J2220-61001 HP-UX SNAplus Installation Guide
  319. J2220-61002 Getting to Know SNAP-IX
  320. J2220-61003 SNAP-IX User Interface Guide
  321. J2220-61004 SNAP-IX Management Guide
  322. J2220-61005 SNAP-IX Configuration Guide
  323. J2220-61006 SNAP-IX Glossary
  324. J2220-61007 SNAP-IX Diagnostics Guide
  325. J2223-61000 SNAP-IX APPC Programmer's Guide
  326. J2223-61001 CSV Programmer's Guide
  327. J2220-61025 HP SNA Products Remote System Configuration Guide
  328.  
  329. Support Products
  330. HP offers a spectrum of support service products to help plan,
  331. implement, operate, and manage your multivendor network throughout the
  332. network lifecycle.
  333.    For more information, contact your HP Representative, or refer to the
  334. HP data sheets for specific support services.
  335.  
  336. From HP Networking Communications Specification Guide, 5091-3821E, 9205,
  337.   addendum 0193
  338. Associated files:  j2223a.plt, j2223a.gal, j2223a.doc
  339. HP-UX SNAplusAPI, Technical Data